Skip to content

gh-150345: Fix wrong reference in BaseSelectorEventLoop docstring#150408

Open
kodsurfer wants to merge 5 commits into
python:mainfrom
kodsurfer:fix-baseselectoreventloop-docstring
Open

gh-150345: Fix wrong reference in BaseSelectorEventLoop docstring#150408
kodsurfer wants to merge 5 commits into
python:mainfrom
kodsurfer:fix-baseselectoreventloop-docstring

Conversation

@kodsurfer
Copy link
Copy Markdown

@kodsurfer kodsurfer commented May 25, 2026

Summary

Fix wrong class reference in BaseSelectorEventLoop docstring.

Details

The docstring in asyncio.selector_events.BaseSelectorEventLoop incorrectly
references events.EventLoop, which does not exist in the module.

events.AbstractEventLoop is the correct reference.

Changes

  • Changed docstring reference from events.EventLoop to events.AbstractEventLoop

Issue

This fixes the documentation issue where:

  • events.EventLoop doesn't exist as an attribute on asyncio.events
  • asyncio.EventLoop (added in Python 3.13) is a platform-specific concrete implementation alias, not an API specification
  • AbstractEventLoop is the appropriate class for API specification documentation

Automerge-Triggered-By: GH:gvanrossum

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 25, 2026

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@python-cla-bot
Copy link
Copy Markdown

python-cla-bot Bot commented May 26, 2026

All commit authors signed the Contributor License Agreement.

CLA signed

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove the NEWS.

@picnixz
Copy link
Copy Markdown
Member

picnixz commented May 27, 2026

  1. Please do not update your branch unless CI is failing.
  2. Make sure that all commits authors signed the CLA. It appears two accounts have committed to this PR.

@kumaraditya303
Copy link
Copy Markdown
Contributor

Automerge-Triggered-By: GH:gvanrossum

Why have you written automerge line by yourself? Is this PR entirely agent generated?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants